home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / webshell / nsIRefreshURI.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-05-08  |  5.7 KB  |  164 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIRefreshURI.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIRefreshURI_h__
  6. #define __gen_nsIRefreshURI_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. #ifndef __gen_nsIURI_h__
  14. #include "nsIURI.h"
  15. #endif
  16.  
  17. /* For IDL files that don't want to include root IDL files. */
  18. #ifndef NS_NO_VTABLE
  19. #define NS_NO_VTABLE
  20. #endif
  21. class nsIChannel; /* forward declaration */
  22.  
  23.  
  24. /* starting interface:    nsIRefreshURI */
  25. #define NS_IREFRESHURI_IID_STR "69efc430-2efe-11d2-9e5d-006008bf092e"
  26.  
  27. #define NS_IREFRESHURI_IID \
  28.   {0x69efc430, 0x2efe, 0x11d2, \
  29.     { 0x9e, 0x5d, 0x00, 0x60, 0x08, 0xbf, 0x09, 0x2e }}
  30.  
  31. class NS_NO_VTABLE nsIRefreshURI : public nsISupports {
  32.  public: 
  33.  
  34.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IREFRESHURI_IID)
  35.  
  36.   /**
  37.       * Load a uri after waiting for aMillis milliseconds. If the docshell
  38.       * is busy loading a page currently, the refresh request will be
  39.       * queued and executed when the current load finishes. 
  40.       *
  41.       * @param aUri The uri to refresh.
  42.       * @param aMillis The number of milliseconds to wait.
  43.       * @param aRepeat Flag to indicate if the uri is to be 
  44.       *                repeatedly refreshed every aMillis milliseconds.
  45.       * @parem aMetaRefresh Flag to indicate if this is a Meta refresh.
  46.       */
  47.   /* void refreshURI (in nsIURI aURI, in long aMillis, in boolean aRepeat, in boolean aMetaRefresh); */
  48.   NS_IMETHOD RefreshURI(nsIURI *aURI, PRInt32 aMillis, PRBool aRepeat, PRBool aMetaRefresh) = 0;
  49.  
  50.   /**
  51.       * Checks the passed in channel to see if there is a refresh header, 
  52.       * if there is, will setup a timer to refresh the uri found
  53.       * in the header. If docshell is busy loading a page currently, the
  54.       * request will be queued and executed when the current page 
  55.       * finishes loading. 
  56.       *
  57.       * @param aChannel The channel to be parsed. 
  58.       */
  59.   /* void setupRefreshURI (in nsIChannel aChannel); */
  60.   NS_IMETHOD SetupRefreshURI(nsIChannel *aChannel) = 0;
  61.  
  62.   /**
  63.       * Parses the passed in header string and sets up a refreshURI if
  64.       * a "refresh" header is found. If docshell is busy loading a page 
  65.       * currently, the request will be queued and executed when 
  66.       * the current page finishes loading. 
  67.       *
  68.       * @param aBaseURI base URI to resolve refresh uri with.
  69.       * @param aHeader  The meta refresh header string.
  70.       */
  71.   /* void setupRefreshURIFromHeader (in nsIURI aBaseURI, in ACString aHeader); */
  72.   NS_IMETHOD SetupRefreshURIFromHeader(nsIURI *aBaseURI, const nsACString & aHeader) = 0;
  73.  
  74.   /**
  75.       * Cancels all timer loads.
  76.       */
  77.   /* void cancelRefreshURITimers (); */
  78.   NS_IMETHOD CancelRefreshURITimers(void) = 0;
  79.  
  80. };
  81.  
  82. /* Use this macro when declaring classes that implement this interface. */
  83. #define NS_DECL_NSIREFRESHURI \
  84.   NS_IMETHOD RefreshURI(nsIURI *aURI, PRInt32 aMillis, PRBool aRepeat, PRBool aMetaRefresh); \
  85.   NS_IMETHOD SetupRefreshURI(nsIChannel *aChannel); \
  86.   NS_IMETHOD SetupRefreshURIFromHeader(nsIURI *aBaseURI, const nsACString & aHeader); \
  87.   NS_IMETHOD CancelRefreshURITimers(void); 
  88.  
  89. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  90. #define NS_FORWARD_NSIREFRESHURI(_to) \
  91.   NS_IMETHOD RefreshURI(nsIURI *aURI, PRInt32 aMillis, PRBool aRepeat, PRBool aMetaRefresh) { return _to RefreshURI(aURI, aMillis, aRepeat, aMetaRefresh); } \
  92.   NS_IMETHOD SetupRefreshURI(nsIChannel *aChannel) { return _to SetupRefreshURI(aChannel); } \
  93.   NS_IMETHOD SetupRefreshURIFromHeader(nsIURI *aBaseURI, const nsACString & aHeader) { return _to SetupRefreshURIFromHeader(aBaseURI, aHeader); } \
  94.   NS_IMETHOD CancelRefreshURITimers(void) { return _to CancelRefreshURITimers(); } 
  95.  
  96. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  97. #define NS_FORWARD_SAFE_NSIREFRESHURI(_to) \
  98.   NS_IMETHOD RefreshURI(nsIURI *aURI, PRInt32 aMillis, PRBool aRepeat, PRBool aMetaRefresh) { return !_to ? NS_ERROR_NULL_POINTER : _to->RefreshURI(aURI, aMillis, aRepeat, aMetaRefresh); } \
  99.   NS_IMETHOD SetupRefreshURI(nsIChannel *aChannel) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetupRefreshURI(aChannel); } \
  100.   NS_IMETHOD SetupRefreshURIFromHeader(nsIURI *aBaseURI, const nsACString & aHeader) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetupRefreshURIFromHeader(aBaseURI, aHeader); } \
  101.   NS_IMETHOD CancelRefreshURITimers(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->CancelRefreshURITimers(); } 
  102.  
  103. #if 0
  104. /* Use the code below as a template for the implementation class for this interface. */
  105.  
  106. /* Header file */
  107. class nsRefreshURI : public nsIRefreshURI
  108. {
  109. public:
  110.   NS_DECL_ISUPPORTS
  111.   NS_DECL_NSIREFRESHURI
  112.  
  113.   nsRefreshURI();
  114.  
  115. private:
  116.   ~nsRefreshURI();
  117.  
  118. protected:
  119.   /* additional members */
  120. };
  121.  
  122. /* Implementation file */
  123. NS_IMPL_ISUPPORTS1(nsRefreshURI, nsIRefreshURI)
  124.  
  125. nsRefreshURI::nsRefreshURI()
  126. {
  127.   /* member initializers and constructor code */
  128. }
  129.  
  130. nsRefreshURI::~nsRefreshURI()
  131. {
  132.   /* destructor code */
  133. }
  134.  
  135. /* void refreshURI (in nsIURI aURI, in long aMillis, in boolean aRepeat, in boolean aMetaRefresh); */
  136. NS_IMETHODIMP nsRefreshURI::RefreshURI(nsIURI *aURI, PRInt32 aMillis, PRBool aRepeat, PRBool aMetaRefresh)
  137. {
  138.     return NS_ERROR_NOT_IMPLEMENTED;
  139. }
  140.  
  141. /* void setupRefreshURI (in nsIChannel aChannel); */
  142. NS_IMETHODIMP nsRefreshURI::SetupRefreshURI(nsIChannel *aChannel)
  143. {
  144.     return NS_ERROR_NOT_IMPLEMENTED;
  145. }
  146.  
  147. /* void setupRefreshURIFromHeader (in nsIURI aBaseURI, in ACString aHeader); */
  148. NS_IMETHODIMP nsRefreshURI::SetupRefreshURIFromHeader(nsIURI *aBaseURI, const nsACString & aHeader)
  149. {
  150.     return NS_ERROR_NOT_IMPLEMENTED;
  151. }
  152.  
  153. /* void cancelRefreshURITimers (); */
  154. NS_IMETHODIMP nsRefreshURI::CancelRefreshURITimers()
  155. {
  156.     return NS_ERROR_NOT_IMPLEMENTED;
  157. }
  158.  
  159. /* End of implementation class template. */
  160. #endif
  161.  
  162.  
  163. #endif /* __gen_nsIRefreshURI_h__ */
  164.